Sertifi API Web Service
Method/Services/FileQuery
Sertifi API Web Service > All Operations Resource Group : /Services/FileQuery (Method)
Description
Returns FileQueryResult object containing the list of files matching the search criteria. If nothing is meet or any error in search parameters, a message describing the error is returned. Return object (FileSummary) provides some parameters like FileId, Status, OwnerEmail, unsigned document count, signed document count and date created of the matched file.
Request (FileQuerySoapIn)

The request body is of type FileQuery.

Request Body Parameters

NameDescriptionData Type
p_ApiCodeThe API code of the site.  This can be found through your Sertifi web interface under Administration -> Account Settings.xml:string
parametersA file can be searched using following parameters:
 - FileNumericId1
   An Integer metadata for the file and which is set using SetSignatureRequestParameters
 - FileDateSigned
   Time at which packetized file was signed. Time format should be in sortable DateTime pattern yyyy'-'MM'-'dd'T'HH':'mm':'ss, eg: 2008-06-15T21:15:07		ArrayOfSearchParameter
Value Element Type Element Sequence SearchParameter Element Sequence parameters Element p_ApiCode Element Sequence FileQuery Element
Response (FileQuerySoapOut)

The response body is of type FileQueryResponse.

Response Body Parameters

NameDescriptionData Type
FileQueryResultResult summary or error message.ArrayOfFileQueryResult
ErrorMessage Element DateLastAction Element DateCreated Element Signed Element Unsigned Element OwnerEmail Element FileStatus Element FileId Element Sequence FileSummary Element Sequence Result Element Sequence FileQueryResult Element Sequence FileQueryResult Element Sequence FileQueryResponse Element
See Also
All Operations Resource Group | Sertifi API Web Service

 

 

© Sertifi, Inc., 2016 All Rights Reserved.

Send comments on this topic.